<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Abstract Scalar Parameter Element</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<h1>Abstract ScalarParameter</h1>

<p>Represents the abstract scalar parameter types.</p>

<h3>Description</h3>

<p>Represents the abstract scalar parameter types, which defines a single-value parameter. </p>

<p>Abstract scalar parameters can provide a selection list. The list 
can be static (defined by the <code>selectionList</code> 
property) or dynamic (defined by the <code>dataSet</code>,
<code>valueExpr</code> and <code>labelExpr</code> 
properties.)  The user can sort this list by specified key and direction(as controlled by the <code>
sortDirection</code>, <code>sortBy</code> and <code>sortByColumn</code> properties).</p>

<h2 class="property">dataSetName</h2>

<p>Refer to a data set for the dynamic selection list.</p>

<h3>Description</h3>

<p>Refer to a data set for the selection list. Once this property is set, the selection list is dynamic.</p>

<h2 class="property">dataType</h2>

<p>The data type for the parameter. </p>

<h3>Description</h3>

<p>The data type for the parameter. The data type controls 
how the Requester formats, parses and validates the parameter. Every type can optionally provide a choice list. 
And, the parameter can require that the user select one of the choices.</p>

<h3>See Also</h3>

<p><code>selectionList</code> property</p>

<h2 class="property">labelExpr</h2>

<p>The prompt for the dynamic choices.</p>

<h3>See Also</h3>

<p><code>valueExpr</code> property</p>

<h3>Description</h3>

<p>An expression that returns the display value for each row in the dynamic list.</p>

<h2 class="property">isRequired</h2>

<p>The flag that indicates whether the value of the parameter is required.</p>

<h3>Description</h3>

<p>The flag indicates whether the value of the parameter is required.
<code>true</code> if the value of the parameter is required.
For string type parameter, if the value is required, it cannot be <code>null</code> or empty.
For other type parameters, required value cannot be <code>null</code>.
</p>

<h2 class="property">listLimit</h2>
<p>List limitation number. </p>

<h3>Description</h3>
<p>Value for the list limitation number. If the limitation is provided, only the top-n choices will 
be available in the parameter request dialog.</p>

<h2 class="property">selectionList</h2>

<p>Defines a selection list for the parameter: static 
list of values from which the user can choose.</p>

<h3>Description</h3>

<p>The parameter selection list provides a developer-defined list of choices. 
Every choice has two parts: a choice and a label. The label can be externalized 
and appears in the UI. The choice is the value passed to the report. For 
example, labels may be "Open" and "Closed", while the values are 0 and 1.</p>
<p>The items in the list are of the type given by the parameter data type.</p>

<h2 class="property">sortBy</h2>

<p>The sort key for parameter values when preview.</p>

<h3>Description</h3>

<p>The sort key for parameter values when preview.Its value can be <i>label</i> or <i>value</i>.</p>

<h2 class="property">sortByColumn</h2>

<p>The expression by which the result sorts.</p>

<h3>Description</h3>

<p>The expression by which the result sorts.</p>


<h2 class="property">sortDirection</h2>

<p>The sort order for parameter values when preview.</p>

<h3>Description</h3>

<p>The sort order for parameter values when preview. Its value can be <i>asc</i> or <i>desc</i>.</p>

<h2 class="property">valueExpr</h2>

<p>The expression to get the value for the choice.</p>

<h3>Description</h3>

<p>The expression on the data row from the dynamic list data set that
 returns the value for the choice.</p>



<h2 class="property">valueExpr</h2>

<p>The expression to get the value for the choice.</p>

<h3>Description</h3>

<p>The expression on the data row from the dynamic list data set that
 returns the value for the choice.</p>

<h3>See Also</h3>

<p><code>lableExpr</code> property</p>


<h2 class="property">valueType</h2>

<p>The parameter type for this scalar parameter.</p>

<h3>Description</h3>

<p>The parameter type for this scalar parameter. Its value can be <i>dynamic</i> or <i>static</i>.</p>

<p>&nbsp;</p>
</body>
</html>